home *** CD-ROM | disk | FTP | other *** search
/ Aminet 23 / Aminet 23 (1998)(GTI - Schatztruhe)[!][Feb 1998].iso / Aminet / game / patch / jst.readme < prev    next >
Text File  |  1998-01-05  |  12KB  |  264 lines
  1. Short:    JOTD Startup for HD Installs & Degrader (bugfix!)
  2. Author:   jffabre@ensica.fr (Jean-François Fabre)
  3. Uploader: jffabre@ensica.fr (Jean-François Fabre)
  4. Type:     game/patch
  5.  
  6.  
  7. JOTD Startup: THE ULTIMATE GAMESTARTER FROM WORKBENCH
  8.  
  9. As you could notice, I created and uploaded many HD-Install & fix programs for
  10. non-dos games, but all of them were standalone, and in case of an error in the
  11. general loader routines, I had to remake the loader (relink) and upload again.
  12.  
  13. Bert Jahn had developped WHDLoad, which solves this problem because it allows to
  14. load small, game-specific loaders and run them using its own degrade/hd/dos code.
  15. This technique allows easy updates in case of bugs or new functionnalities.
  16.  
  17. That's what I decided to do myself. JST was born from a 8-hour adaptation of
  18. my link library. It's an equivalent to WHDLoad but a bit more powerful,
  19. as the system can be called in the slave loader, messages can be printed,
  20. a gui can be opened, there are lots of cool functions, and much more.
  21. It also allows easier programming of loaders (but WHDLoad is still cool!),
  22. and can run normal DOS programs in degraded mode (68060 support).
  23.  
  24. WHY THIS PROGRAM HERE:
  25.  
  26. I uploaded it because it's needed but not included in my new installs and also
  27. Keith Krellwitz ones, because he uses my code. This allows to save space in the
  28. archives and avoids leaving old versions of JST around if a bug shows up.
  29.  
  30. ***NEW SINCE V0.8***: JOTDStartup can also be used as a DEGRADER for all your old DOS
  31. games with the EXECUTE command. As a bonus, CLI-only games will be startable from
  32. WB if you specify JST as default tool and the EXECUTE tooltype. I will give up the
  33. developpement of run500. Now JST with EXECUTE will replace it in a much better way.
  34.  
  35. JOTD HD Startup is © 1995-1997 Jean-François FABRE
  36. JOTDStartup is © 1997 Jean-François FABRE
  37.  
  38.  
  39. JOTDStartup is SHAREWARE!
  40.  
  41. From V0.3 I decided to ask a fee of US$10, 20DM, 7£ or 50FF to be able to become
  42. a registered user. However, I will register whoever I think he or she did something
  43. cool for me (already sent disks, money, sports cars, Sandra Bullock clones...).
  44. Lots of people are already on the list. If you think I forgot you, contact me.
  45.  
  46. To register, send the money to:
  47.  
  48. Jean-François Fabre
  49. 19 Rue Emile Duploye
  50. 34500 BEZIERS
  51. FRANCE
  52.  
  53. Specify your e-mail or send a blank disk with the money (for non-internet users),
  54. and I'll send you the registered version of JST (+the latest installs for the
  55. ones who sent a floppy but specify which ones in priority as the whole archive is big)
  56.  
  57.  
  58. If you think this is too expensive, you can use the "limited" shareware version.
  59. It has no limitations compared to older free releases but the new features will
  60. be reserved to registered version. However, if I fix a bug, it will be fixed in
  61. both registered and shareware version of course.
  62. All the future loaders will be compatible with the limited version.
  63.  
  64. I hope you understand JST and all the loaders were hard work for me, that's why
  65. I decided it.
  66. The money will be shared between me and the loaders programmers using JST
  67. (2 for the moment, including me).
  68.  
  69.  
  70. OPTIONS:
  71.  
  72. You can select the options:
  73.  
  74. - From the CLI by typing the arguments (JST ? for help)
  75. - From the WB by activating/disabling the tooltypes
  76.  
  77. Some have effect only on loaders that support them. They will be noted are *OPTIONAL*
  78. Some have effect on all loaders. They're noted as *GENERAL*
  79.  
  80. Here's a short description of the options.
  81.  
  82. - OBJNAME="object": lets you specify an object name (icon launch).
  83.  
  84. - NTSC (GENERAL): default for loader is PAL. NTSC changes this to NTSC (really?)
  85.  
  86. - TRAINER (OPTIONAL): activates trainer when there is one. It can be infinite lives, time, etc...
  87.  
  88. - QUIET (GENERAL): displays nothing and opens no window. No error messages, and no author message.
  89.   Be sure that everything works OK before selecting this one.
  90.  
  91. - NOCACHES/NOCACHE (GENERAL): Sets CACR to 0. All caches are disabled. 68060 supported.
  92.  
  93. - LEAVECACHES (GENERAL): Don't touch the caches. Disabled by NOCACHES
  94.  
  95. - NOFAST (GENERAL): Always allocates extension memory
  96.   from chip memory. If you got crap sprites, this could help. USeless in the case of 512K mem games.
  97.  
  98. - HDLOAD (GENERAL): to save some memory, you can load from HD instead of caching all the files in RAM.
  99.   It works for diskfiles and normal files.
  100.   Useless in games with only 1 diskfile, use LOWMEM instead.
  101.  
  102. - EXECUTE (DOS GAMES): this tooltype will allow you to use JST as a normal degrader like
  103.   KillAGA, but with 68060 support and more control over the system. If you specify EXECUTE,
  104.   JST will try to execute the object you passed, degrading the display to PAL (or NTSC if
  105.   you select NTSC), zeroing the VBR (unless you specify LEAVEVBR), disabling 68060 specific
  106.   caches (unless you set LEAVECACHES) and setting the sprites to OCS size (required by most
  107.   games). Of course, loader-specific options like LOWMEM, HDLOAD, NOFAST, SAVEDIR and DELAY
  108.   will not work.
  109.  
  110. - USERDATA: if the user passes a string to this argument/tooltype an wants to run a program
  111.   using EXECUTE (degrader features only), then this string hold the arguments of the program.
  112.   If it's a loader, it can be used to specify some parameters to the loader. Useful for disk
  113.   rippers to pass track start/end. Max length allowed is 80 characters.
  114.  
  115. - LOWMEM (OPTIONAL): will not cache diskfiles in memory. Read directly from disk. Useful if you've
  116.   got a A1200/020/NoFast. With normal files, LOWMEM consumes even less memory than HDLOAD. Some
  117.   loaders may bring up and error message or crash with an exception.
  118.   In that case they don't support this option yet :)
  119.  
  120. - NOOSSWAP (OPTIONAL): Disables in game HD loads/saves. Depending on the loaders, NOOSSWAP
  121.   will try to access the floppy when you try to save/load a game, or will do nothing.
  122.   If you don't select NOOSSWAP, if the game has some data to write, it will do it on your
  123.   hard drive. It's rather safe (I've been using it for a while now) but you should avoid
  124.   filesystems or disk caches that perform copyback caching (AFS, possible in Dynamicache).
  125.   This is not generally harmful, except if you quit by a reset or the game locks. In that
  126.   case, your hard drive can be unvalidated.
  127.  
  128. - DELAY (GENERAL): Waits a little while after every OS swap.
  129.   This can be useful for low speed media. It allows the drive to stop and leaves time for
  130.   interrupts to be processed before the system is frozen again (CD32).
  131.  
  132. - SAVEDIR (OPTIONAL): allows the user to specify a directory where the game data like hiscores
  133.   or savegames will be saved/loaded. Some loaders with HD saves don't support it yet.
  134.   This function is only available to registered users.
  135.  
  136. - DEADLY (GENERAL): "Clean" installs should run with DEADLY on, because it trashes ExecBase
  137.   and redirects interrupt vectors to an error message, so no ROM code is called if an
  138.   unexpected interrupt occurs. Leaving Execbase alive can be unreliable and can trigger 81000005
  139.   GURUs in the case the loader still uses system routines such as AllocMem() 
  140.   (which is not recommended, but it's up to the programmer. I generally remove all system
  141.   code in the game).
  142.  
  143. Some options are here for debug and developpement purpose only:
  144.  
  145. - DEBUG (GENERAL): useful only for bug reports. Makes a memory image on exit. Can be FULL or REGS
  146. - LEAVEVBR (GENERAL): useful only for debugging purposes, and with a debugger such as Action-Replay,
  147.           HRTMon or ThrillKill. Don't select it unless you want to debug.
  148. - TEST (GENERAL): The loader will not start. Only the options selected will be displayed.
  149. - VERBOSE (GENERAL): The loader will display information while initializing (memory, files...)
  150. - DEADLY (GENERAL): Your loaders should all run with this one on
  151.  
  152. Examples from CLI for normal JST objects:
  153.  
  154. JST MagicPocketsHD NOCACHES DELAY NTSC
  155.  
  156. JST HookHD NOFAST HDLOAD SAVEDIR=ram: (registered users only can use SAVEDIR)
  157.  
  158. Examples from CLI for normal DOS executables:
  159.  
  160. JST Dune NOCACHES EXECUTE (the game does not like caches)
  161.  
  162. JST ssboot EXECUTE USERDATA=SWOS (the ssboot executable needs SWOS as an argument)
  163.  
  164. JST AGADemo LEAVEVBR LEAVECACHES NTSC EXECUTE (the demo likes caches and does not care about the VBR
  165. relocated in fastmem, but I've got a multiscan WB, and I want to boot in 15KHz with NTSC)
  166.  
  167. Of course if the dos executable sets PAL or opens an intuition screen, display features of JST
  168. will be cancelled.
  169.  
  170. PROBLEMS:
  171.  
  172. Some error messages can occur before or after the game has started:
  173.  
  174. - Object is not relocatable: the game-specific loader must not address variables in an
  175.   absolute way (this error is more for programmers)
  176.  
  177. - Invalid Object: someone tried to load non-loader objects or other files. To run a normal DOS
  178.   program with JST don't forget to set EXECUTE tooltype/argument.
  179.  
  180. - Not enough memory: try to free some memory. Playing with NOFAST and HDLOAD and boot without
  181.   startup-sequence can help too.
  182.  
  183. - Unsupported version: some games exist in different versions. I try to support some of them,
  184.   but if the program does not recognize the version, it can display this message (it can crash too!).
  185.  
  186. - Exception: <cryptic message> : some illegal instruction was encountered while the game executes.
  187.   Try NOCACHES and NOFAST to see if it helps. Else report me/patch author the error with accuracy.
  188.  
  189. - Uninitialized level <X> interrupt: remove the DEADLY mode :)
  190.  
  191. - Wrong virtual disk ID: patch error. Contact author.
  192.  
  193. - Diskfile not found, Disk Read Error: in HDLOAD mode, a file is missing.
  194.  
  195. - GetDiskPointer called while in LOWMEM mode: LOWMEM is not possible with this loader.
  196.  
  197. - Not enough memory while you've got plenty: check the priority of your different
  198.   memory expansion cards, because JST uses MEMF_REVERSE, and maybe that's the cause. Use the
  199.   VERBOSE option to see what's the problem.
  200.  
  201. If the game simply hangs or resets, check that you don't have some MMU related program
  202. running (enforcer, VMM...) or low level patches like Fastexec. My patches are reported
  203. to work with softkicked amigas, though.
  204. Some versions of the 68060.library can bring up problems too (gfx errors)
  205.  
  206. The game can crash if it finds an exception and there is not enough memory to restore the
  207. system and display the exception message. Buy some more mem :-)
  208.  
  209. Some old versions of JST may be able to run a loader while the newest cannot. In that case,
  210. please report me the problem urgently.
  211.  
  212. History: see the file 'history.readme' in the JST distribution
  213.  
  214.  
  215. STILL TO DO:
  216.  
  217. - Prefetch diskfile data in memory to avoid too much os swaps in LOWMEM mode
  218.   (Registered users only)
  219.  
  220. - Some other secret cool features for registered version :)
  221.  
  222. DISCLAIMER:
  223.  
  224. I'm not responsible for any damage caused directly or indirectly by this piece
  225. of software.
  226.  
  227. DISTRIBUTION:
  228.  
  229. The shareware version of JST and my HD work can be distributed freely. However, I'd appreciate
  230. that you drop me a line if you include it in a coverdisk or PD collection.
  231. If you like (or you dislike) this piece of software, you can e-mail me.
  232.  
  233. The registered version of JST should NOT be distributed.
  234.  
  235. ME:
  236.  
  237. Visit my patch page, where all my HD work is gathered, along with some other
  238. quality installers (all for original software), and some other interesting
  239. related freeware stuff:
  240.  
  241. http://www.ensica.fr/~jffabre/patches.html
  242.  
  243. And my home page (totally stupid stuff):
  244.  
  245. http://www.ensica.fr/~jffabre/ (english)
  246. http://www.ensica.fr/~jffabre/index_fr.html (french)
  247.  
  248. E-mail: jffabre@club-internet.fr (at home, small files only, checked very often)
  249. Or:     jffabre@ensica.fr (You can send big data files from unsupported versions, etc...)
  250.  
  251.  
  252. Jeff
  253.  
  254.  
  255. ============================= Archive contents =============================
  256.  
  257. Original  Packed Ratio    Date     Time    Name
  258. -------- ------- ----- --------- --------  -------------
  259.     5900    2521 57.2% 26-Dec-97 01:09:04  history.readme
  260.    40312   16630 58.7% 26-Dec-97 01:09:04  jst
  261.    11536    5238 54.5% 26-Dec-97 01:09:04  jst.readme
  262. -------- ------- ----- --------- --------
  263.    57748   24389 57.7% 27-Dec-97 19:22:52   3 files
  264.